CxHmiCas3 Properties

The CxHmiCas3 object contains the following properties:

Property

Type

 Read Only Description

AllowChanges

Boolean

No

Returns/sets whether or not runtime user changes are allowed.

Appearance

Short

No

Appearance specifies whether the object boundary (graph, cell in the grid, view, etc.) will have a 3D effect or a flat appearance. Options are 0 — Flat or 1 — 3D. Default is 0 — Flat.

BackgroundColorOverride

Long

No

Returns/sets the background color override.

BlinkIcon

Boolean

No

Enables/disables blinking of the icon on unacknowledged alarms.

Note: Alarm blinking is available only for points created using the CygNet Enhanced Point Scheme (Point Scheme number 1 - 15). The blinking feature is not available for points created using the default CygNet Standard Point Scheme (Point Scheme number 0).

BlinkLeft

Boolean

No

Enables/disables blinking of the leftmost textual column on unacknowledged alarms.

Note: Alarm blinking is available only for points created using the CygNet Enhanced Point Scheme (Point Scheme number 1 - 15). The blinking feature is not available for points created using the default CygNet Standard Point Scheme (Point Scheme number 0).

BlinkUnack

Boolean

No

Enables/disables blinking of unacknowledged alarms.

Note: Alarm blinking is available only for points created using the CygNet Enhanced Point Scheme (Point Scheme number 1 - 15). The blinking feature is not available for points created using the default CygNet Standard Point Scheme (Point Scheme number 0).

BorderStyle

Short

No

Returns/sets the border style (0 - None, 1 - Fixed Single).

ButtonsCol1

Boolean

No

Enables/disables the first buttons column.

ButtonsCol1Action

Integer

No

Returns/sets the action associated with clicking a button in the first buttons column. Possible values for this property are:

  • 0 — Acknowledge alarm
  • 1 — Launch Alarm Suppression Settings dialog
  • 2 — Hide alarm
  • 3 — Clear alarm
  • 4 — Launch Alarm History dialog box
  • 5 — Launch a Point Properties dialog box
  • 6 — Fires the OnButtonClick event.

ButtonsCol1Text

String

No

Returns/sets the button text for the first buttons column.

ButtonsCol2

Boolean

No

Enables/disables the last buttons column.

ButtonsCol2Action

Integer

No

Returns/sets the action associated with clicking a button in the last buttons column. Possible values for this property are:

  • 0 — Acknowledge alarm
  • 1 — Launch Alarm Suppression Settings dialog box
  • 2 — Hide alarm
  • 3 — Clear alarm
  • 4 — Launch Alarm History dialog box
  • 5 — Launch Point Properties dialog box
  • 6 — Fires the OnSecondButtonClick event.

ButtonsCol2Text

String

No

Returns/sets the button text for the last buttons column.

CasCtrlAttributesDescriptions

String

No

Returns/sets the XML representing the descriptions of custom attributes.

CasCtrlAttributesValues

String

No

Returns/sets the XML representing the values of custom attributes.

ColorMode

Integer

No

Returns/sets the color mode (0 — single color mode, 1 — dual color mode).

Columns

String

No

Specifies the number of columns that are defined for the object or the XML that represents the list of displayed columns. Use the OCX Properties dialog box to select.

For a WatchList Tool, Columns specifies the identifier of each column. Items are semicolon separated.

ContextMenuXml

String

No

ContextMenuXml identifies an XML string that defines the contents and Event IDs for the object’s custom context menu. See Custom Context Menus for more information about configuring custom menus for ActiveX Controls.ActiveX Control ExampleThe following example includes one new menu item (New Item).ContextMenuXML for Event Summary Control<CustomContextMenu> <items> <ContextMenuDef> <itemsHidden/> <items> <MenuItem Disable1="false" Disable2="false" Disable3="false" Description="New Context Menu Item (at bottom)" EventID="NEWID"/> </items> </ContextMenuDef> </items> </CustomContextMenu>CAS View Control Example The CAS View Control includes additional options to hide default menu items. The following example includes one new menu item (New Item) and one hidden item (Suppress…). See CAS View Control.ContextMenuXML for CAS View Control<CustomContextMenu> <items> <ContextMenuDef> <itemsHidden> <DefaultMenuItem MenuId="1021" Desc="Suppress..." Type="0"/> </itemsHidden> <items> <MenuItem Disable1="true" Disable2="false" Disable3="false" Description="New Item" EventID="NEWID"/> </items> </ContextMenuDef> </items> </CustomContextMenu>

CustomIconColor

Boolean

No

Returns/sets the icon color mode (False — foreground color, True — background color).

DClickProperties

Boolean

No

Returns/sets whether or not double-clicking a row will launch a Point Properties dialog box.

EmptySpaceColorOverride

Long

No

Returns/sets the empty space color override. The empty space is the area to the right and below the CAS View Control grid.

Filter

String

No

Specifies the XML representing the alarm filter.

FocusColor

Long

No

Returns/sets the focus rectangle color.

Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'

FocusWidth

Integer

No

Returns/sets the focus rectangle border width.

Font

String

No

Font specifies the font for the object.

For TheView, this property specifies the default font for text-based objects.

For other objects, it specifies the font for the instance of the object. The object’s font takes precedence over the font set for TheView.

Click … to view the Font dialog box, which you can use to configure the font. The default is MS Shell Dlg (MS Sans Serif, regular, 8 pt). Script subtype is string.

Note: In script, you can set font properties using "-13, Arial" for example.

ForegroundColorOverride

Long

No

Returns/sets the foreground override color.

IconPathAck

String

No

Returns/sets the path to the custom Acknowledged icon.

IconPathOos

String

No

Returns/sets the path to the custom Out-of-Service icon.

IconPathUnack

String

No

Returns/sets the path to the custom Unacknowledged icon.

IconPathUnknown

String

No

Returns/sets the path to the custom Unknown icon.

OverrideBackgroundColors

Boolean

No

Enables/disables background color override.

OverrideColors

Boolean

No

Enables/disables text color override.

OverrideEmptySpaceColor

Boolean

No

Enables/disables empty space color override. The empty space is the area to the right and below the CAS View Control grid.

OverrideFocusColors

Boolean

No

Enables/disables focus color override.

OverrideForegroundColors

Boolean

No

Enables/disables foreground color override.

PropertiesXml

String

No

Returns/sets the XML representing the grid properties.

RowHeight

Integer

No

Returns/sets the default row height.

SelectionBackgroundColor

Long

No

Returns/sets the multi-selection background color.

Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'

SelectionForegroundColor

Long

No

Returns/sets the multi-selection foreground color.

Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'

ShowGridLines

Boolean

No

Enables/disables grid lines.

ShowIcon

Boolean

No

Enables/disables alarm icon visibility.

ShowLineColor

Boolean

No

Enables/disables entire row alarm coloring (i.e. if this property is set to True, the entire row will be shown in the row’s alarm color).

SiteServices

String

No

Returns/sets the semicolon-delimited list of CAS Site.Services.

Sorting

String

No

Returns/sets the XML representing the default sorting mode.

SortRuntime

Boolean

No

Enables/disables runtime sorting.

Sounds

String

No

Returns/sets the XML representing the sound configuration.

TooltipString

String

No

Returns/sets the tokenized tooltip string.

UseCustomIconAck

Boolean

No

Enables/disables the custom Acknowledged icon.

UseCustomIconOos

Boolean

No

Enables/disables the custom Out-of-Service icon.

UseCustomIconUnack

Boolean

No

Enables/disables the custom Unacknowledged icon.

UseCustomIconUnknown

Boolean

No

Enables/disables the custom Unknown icon.

WrapColumns

Boolean

No

Enables/disables column word wrap.

Back to top